package gpl.pierrick.brihaye.aramorph;

import java.util.Iterator;

/**
 * Holds a list of <code>DictionaryEntry</code>s with
 * helping mehtods to retrieve them
 * @author Pierrick Birhaye
 */
public interface Dictionary {

	/**
	 * Checks whether this dictionary contains entries with the given unvocalized
	 * @param unvocalized the unvocalized to be searched for
	 * @return true if this dictionary contains an entry with the given unvocalized
	 */
	public boolean contains(String unvocalized);

	/**
	 * Returns an iterator for all dictionary entries with the given unvocalized
	 * @param unvocalized the unvocalized to be searched for
	 * @return an iterator for all dictionary entries with the given unvocalized
	 */
	public Iterator<DictionaryEntry> getIterator(String unvocalized);

	/**
	 * Returns an iterator for all dictionary entries with the given gloss
	 * @param gloss the gloss to be searched for
	 * @return an iterator for all dictionary entries with the given unvocalized
	 */
	public Iterator<DictionaryEntry> getIteratorForGloss(String gloss);
}
